Get Tool

Used to retrieve a specific tool by its ID. This allows you to fetch detailed information about a particular tool including its configuration, actions, authentication settings, and metadata.

API Endpoint

Property	Value
Request Method	GET
Request URL	https://api.seliseblocks.com/tools/{tool_id}

Request

Request Example

curl -X GET 'https://api.seliseblocks.com/tools/{tool_id}?project_key=YOUR_PROJECT_KEY' \
  -H 'accept: application/json'

Path Parameters

Field	Type	Required	Description
tool_id	string	Yes	The unique identifier of the tool.

Query Parameters

Field	Type	Required	Description
project_key	string	No	The project key for your project.

Request Headers

Field	Type	Required	Description
accept	string	Yes	Accepted response format. Use application/json

note

Tool Retrieval Details

• Returns complete tool configuration including all actions and settings
• Includes both API and MCP server configurations if applicable
• Provides authentication configuration details (tokens are masked for security)
• Returns version history and usage statistics
• Access is controlled by project permissions

tip

Use cases for retrieving tool details:

• Viewing complete tool configuration for documentation
• Auditing tool settings and authentication
• Checking action definitions and parameters
• Reviewing version history and changes
• Monitoring tool usage statistics
• Debugging integration issues

The response includes:

• Basic metadata (name, description, type, status)
• Complete API or MCP configuration
• All available actions with parameters
• Authentication settings (with sensitive data masked)
• Rate limiting and retry configurations
• Webhook settings
• Version information and change history
• Usage statistics

Response

Success Response (200 OK)

Returns the complete tool object with all configuration details.

{
  "_id": "tool_123",
  "CreatedDate": "2025-12-01T10:30:00Z",
  "LastUpdatedDate": "2026-01-10T14:20:00Z",
  "CreatedBy": "user_456",
  "Language": "en",
  "LastUpdatedBy": "user_789",
  "OrganizationIds": ["org_001"],
  "Tags": ["customer", "api", "production"],
  "Name": "Customer API",
  "Description": "API for managing customer data and interactions",
  "Type": "api",
  "Status": "active",
  "APIConfig": {
    "BaseURL": "https://api.example.com/v1",
    "Actions": {
      "get_customer": {
        "ActionId": "action_001",
        "Name": "Get Customer",
        "Description": "Retrieve customer information by ID",
        "Endpoint": "/customers/{id}",
        "Method": "GET",
        "InputParameters": {
          "id": {
            "Name": "id",
            "Type": "string",
            "Description": "Customer ID",
            "Required": true,
            "Location": "path"
          }
        },
        "TimeoutSeconds": 30,
        "Enabled": true
      }
    },
    "AuthConfig": {
      "AuthType": "bearer",
      "APIToken": "***masked***",
      "AuthKeyLocation": "header",
      "AuthKeyName": "Authorization",
      "AuthKeyPrefix": "Bearer"
    },
    "RateLimitConfig": {
      "Enabled": true,
      "RequestsPerMinute": 100,
      "RequestsPerHour": 6000,
      "BurstSize": 10
    }
  },
  "CurrentVersion": "1.2.0",
  "TotalUses": 1547,
  "LastUsed": "2026-01-12T06:15:30Z"
}

Main Response Fields

Field	Type	Description
_id	string	Unique identifier of the tool.
CreatedDate	string	ISO 8601 timestamp when the tool was created.
LastUpdatedDate	string	ISO 8601 timestamp when the tool was last updated.
CreatedBy	string	User ID who created the tool.
Language	string	Language code for the tool.
LastUpdatedBy	string	User ID who last updated the tool.
OrganizationIds	array	Array of organization IDs this tool belongs to.
Tags	array	Array of tags for categorization.
Name	string	Display name of the tool.
Description	string	Detailed description of the tool's purpose.
Type	string	Tool type: "api", "mcp_server", "webhook", "graphql".
Status	string	Tool status: "active", "inactive", "deprecated", "maintenance".
APIConfig	object	API tool configuration (present for API tools).
MCPConfig	object	MCP server configuration (present for MCP tools).
Tutorial	string	Tutorial or guide for using the tool.
DocumentationURL	string	URL to external documentation.
CurrentVersion	string	Current active version of the tool.
Versions	object	Version history with snapshots.
Category	string	Tool category for organization.
TotalUses	integer	Total number of times the tool has been used.
LastUsed	string	ISO 8601 timestamp of last usage.

API Configuration Fields

Field	Type	Description
BaseURL	string	Base URL for the API.
Actions	object	Dictionary of available actions.
AuthConfig	object	Authentication configuration.
Timeout	integer	Default timeout in seconds.
Headers	object	Default headers for all requests.
RateLimitConfig	object	Rate limiting configuration.
RetryConfig	object	Retry behavior configuration.
WebhookConfig	object	Webhook notification configuration.
APISchema	string	API schema definition.
OpenAPISpec	object	OpenAPI specification.
LastModified	string	ISO 8601 timestamp of last modification.

Action Configuration Fields

Field	Type	Description
ActionId	string	Unique identifier for the action.
Name	string	Display name of the action.
Description	string	Description of what the action does.
Endpoint	string	API endpoint path.
Method	string	HTTP method: "GET", "POST", "PUT", "DELETE", "PATCH".
InputParameters	object	Dictionary of input parameters.
OutputParameters	object	Dictionary of expected output parameters.
OutputParametersExtraction	object	Rules for extracting output from response.
InputSchema	string	JSON schema for input validation.
OutputSchema	string	JSON schema for output validation.
RetryConfig	object	Action-specific retry configuration.
TimeoutSeconds	integer	Action-specific timeout in seconds (default: 30).
Enabled	boolean	Whether the action is enabled.
TestStatus	boolean	Whether the action has been tested.
CreatedAt	string	ISO 8601 timestamp of action creation.
LastModified	string	ISO 8601 timestamp of last modification.
LastTested	string	ISO 8601 timestamp of last test.
Tags	array	Tags for the action.
RequiresApproval	boolean	Whether action requires user approval.
ApprovalPrompt	string	Custom prompt for approval request.
ApprovalTimeout	integer	Timeout for approval in seconds (default: 300).
AutoRejectOnTimeout	boolean	Auto-reject if approval times out.

MCP Configuration Fields

Field	Type	Description
ServerURL	string	URL of the MCP server.
Transport	string	Transport protocol (e.g., "streamable_http").
Headers	object	Custom headers for MCP requests.
QueryParams	object	Query parameters for MCP requests.
TrustMCPServer	boolean	Whether to trust server SSL certificates.
Actions	object	Dictionary of MCP actions (similar to API actions).
AuthConfig	object	MCP-specific authentication configuration.
RateLimitConfig	object	Rate limiting configuration for MCP.
LastModified	string	ISO 8601 timestamp of last modification.
CreatedAt	string	ISO 8601 timestamp of creation.
RequiresApproval	boolean	Whether MCP actions require approval.
ApprovalPrompt	string	Custom approval prompt.
ApprovalTimeout	integer	Approval timeout in seconds.

Authentication Configuration Fields

Field	Type	Description
AuthType	string	Type: "none", "bearer", "basic", "oauth2", "api_key".
APIToken	string	API token (masked in responses).
AuthKeyLocation	string	Location: "header", "query".
AuthKeyName	string	Name of the auth key/header.
AuthKeyPrefix	string	Prefix for auth value (e.g., "Bearer").
Username	string	Username for basic auth.
Password	string	Password for basic auth (masked).
OAuth2Config	object	OAuth 2.0 configuration.
CustomHeaders	object	Custom authentication headers.
CustomQueryParams	object	Custom authentication query parameters.

Error Response (422 Unprocessable Entity)

Returns validation error details when the request parameters are invalid.

{
  "detail": [
    {
      "loc": [
        "path",
        "tool_id"
      ],
      "msg": "invalid tool identifier format",
      "type": "value_error"
    }
  ]
}

Error Response Fields

Field	Type	Description
detail	array	Array of validation error objects.
loc	array	Location of the error in the request (e.g., path, query).
msg	string	Human-readable error message.
type	string	Error type identifier.

Error Codes

Status Code	Description	Response Type
200	Successful Response	Success
400	Bad Request - Invalid request	Bad Request
404	Not Found - Tool does not exist	Not Found
422	Validation Error - Invalid request parameters	Unprocessable Entity